/*
 * Sonatype Nexus (TM) Open Source Version
 * Copyright (c) 2008-present Sonatype, Inc.
 * All rights reserved. Includes the third-party code listed at http://links.sonatype.com/products/nexus/oss/attributions.
 *
 * This program and the accompanying materials are made available under the terms of the Eclipse Public License Version 1.0,
 * which accompanies this distribution and is available at http://www.eclipse.org/legal/epl-v10.html.
 *
 * Sonatype Nexus (TM) Professional Version is available from Sonatype, Inc. "Sonatype" and "Sonatype Nexus" are trademarks
 * of Sonatype, Inc. Apache Maven is a trademark of the Apache Software Foundation. M2eclipse is a trademark of the
 * Eclipse Foundation. All other trademarks are the property of their respective owners.
 */
package org.sonatype.nexus.selector;

import java.util.Optional;
import java.util.Set;

/**
 * An interface for resolving variables to values.
 *
 * @since 3.0
 */
public interface VariableResolver
{
  /**
   * Resolve a given {@code variable} to its underlying value.
   *
   * @param variable to be resolved
   * @return resolved value
   */
  Optional<Object> resolve(String variable);

  /**
   * Get the set of variables that are resolvable by this resolver.
   *
   * @return the set of resolvable variables
   */
  Set<String> getVariableSet();
}
